// Magic Software, Inc.
// http://www.magic-software.com
// Copyright (c) 2000, All Rights Reserved
//
// Source code from Magic Software is supplied under the terms of a license
// agreement and may not be copied or disclosed except in accordance with the
// terms of that agreement.  The various license agreements may be found at
// the Magic Software web site.  This file is subject to the license
//
// RESTRICTED USE SOURCE CODE
// http://www.magic-software.com/License/restricted.pdf

#ifndef MGCCONTROLLER_H
#define MGCCONTROLLER_H

#include "MgcObject.h"


class MgcController : public MgcObject
{
    MgcDeclareRTTI;
    MgcDeclareStream;

public:
    enum RepeatType
    {
        RT_CLAMP,
        RT_WRAP,
        RT_CYCLE,
        RT_QUANTITY
    };

    RepeatType& Repeat ();

    MgcReal& MinTime ();
    MgcReal& MaxTime ();
    MgcReal& Phase ();
    MgcReal& Frequency ();

    bool& Active ();
    bool Active () const;

    virtual void SetObject (MgcObject* pkObject);
    MgcObject* GetObject () const;
    MgcController* GetNext () const;

    virtual bool Update (MgcReal fAppTime) = 0;

protected:
    // abstract base class
    MgcController ();

    // Conversion from application time units to controller time units.
    // Derived classes may use this in their update routines.
    MgcReal GetControlTime (MgcReal fAppTime);

    RepeatType m_eRepeat;
    MgcReal m_fMinTime, m_fMaxTime, m_fPhase, m_fFrequency;
    MgcObject* m_pkObject;
    MgcController* m_pkNext;
    bool m_bActive;

    // MgcObject is a friend for internal list handling.  It needs access to
    // m_pkObject and m_pkNext.
    friend class MgcObject;
};

MgcSmartPointer(MgcController);
MgcRegisterStream(MgcController);
#include "MgcController.inl"

#endif
